home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / jdic15.zip / JREADER.DOC < prev    next >
Text File  |  1992-01-12  |  9KB  |  197 lines
  1.  
  2. J R E A D E R
  3.  
  4. Japanese Text Reader with Online Dictionary Search & Yomikata Lookup
  5. ====================================================================
  6.  
  7. Version 1.1 (January 1992) 
  8.  
  9. INTRODUCTION 
  10. ------------ 
  11.  
  12. This program provides a capability to display a text file  containing  Japanese 
  13. characters  (kana  &  kanji) with the option of looking up displayed words in a 
  14. Japanese/English dictionary file or in MOKE's kanji-to-kana yomikata file.  
  15.  
  16. The  Japanese  characters in the text files can either be in the EUC,  New-JIS, 
  17. Old-JIS or Shift-JIS codes.  In the case of EUC and  Shift-JIS,  hankaku  codes 
  18. are not supported. A file containing other codes, such as NEC-JIS, etc., can be 
  19. concerted  into  one  of  the  supported codes using utilities such as "jc" and 
  20. "jis". 
  21.                  
  22. Although JREADER is intended to help non-Japanese people read Japanese language 
  23. text files,  it can also  be  used  by  Japanese  to  read  English  text.  Its 
  24. usefulness in this role is limited by the dictionary, which is more oriented to 
  25. the  Japanese  to English mode,  and the fact that the dictionary search cannot 
  26. cope with things like  English's  "strong"  verbs  (swim/swam/swum,  be/am/are, 
  27. go/went, etc.). 
  28.  
  29. JREADER  is  an  extension  of  the  author's JDIC (Japanese/English Dictionary 
  30. Display) program,  which  has  been  designed  specifically  to  operate  on  a 
  31. dictionary  in  the  "EDICT"  format used by the MOKE (Mark's Own Kanji Editor) 
  32. Japanese text editor.  As with JDIC,  JREADER's operating environment has  been 
  33. designed  to  be similar to MOKE's,  and it uses the same environment variables 
  34. and control file as MOKE.  Along with JDIC,  it will be updated to  track  MOKE 
  35. versions (at present it is aligned with the beta-test version of MOKE2.1.) 
  36.  
  37. The  executable  code  and  documentation  of JREADER is hereby released to the 
  38. "public domain".  All usage of this program is at the user's risk, and there is 
  39. no warranty on its performance. 
  40.  
  41. All the Japanese displayed is in kana and kanji, so if you cannot read at least 
  42. hiragana  and katakana,  this program will not be much use for you.  The author 
  43. has NO intention of producing a version using romanized Japanese. 
  44.  
  45. THIS DOCUMENT
  46. -------------
  47.  
  48. JREADER is an extension of JDIC, and shares a similar operating method as JDIC. 
  49. Consequently this document file only includes details of where JREADER  differs 
  50. from JDIC. Please make sure you have and read the appropriate JDICnn.doc file. 
  51.  
  52. INSTALLATION
  53. ------------
  54.  
  55. This  program  is  distributed  in  a "zoo" archive (jdicnn.zoo) containing the 
  56. files of both JDIC and JREADER. Follow the installation details in JDICnn.doc. 
  57.  
  58. ENVIRONMENT
  59. -----------
  60.  
  61. JREADER uses the same environment variables and moke.rc  fields  as  JDIC  (and 
  62. MOKE). These affect things like paths and colours. 
  63.  
  64. OPERATION
  65. ---------
  66.  
  67. JREADER is simple to operate. The command-line invocation is: 
  68.  
  69.          jreader <options> text-file
  70.  
  71. The same -l,  -f,  and -bnn options are used as in JDIC.  In addition,  JREADER 
  72. uses: 
  73.  
  74.  -sn (2 < n < 8) specifies that the text window is to use n/10 of  the  screen, 
  75.                  The default is n = 7. 
  76.  
  77.  -ddictionary-file specifies the file that is to be  used  as  the  dictionary, 
  78.                    along  with an index file with an extension of ".jdx".  This 
  79.                    latter file must be created using the  JDXGEN  utility.  The 
  80.                    default is "edict", with "edict.jdx" as the index file. 
  81.  
  82. The working screen of JREADER contains two windows. The upper displays the text 
  83. being read,  the lower displays control  information  and  the  dictionary  and 
  84. yomikata search results. 
  85.  
  86. The first screenful of the text file is displayed when the program starts. From 
  87. then on most operation is by single keystroke commands. They are: 
  88.  
  89. <PgDn> reads the next screen of the file.  The last line of the previous screen 
  90. is repeated as the first line of the next.
  91.  
  92. <PgUp>  reads  the  previous  screen of the file.  The backspacing technique is 
  93. somewhat crude, and may under or overshoot the start of the previous screen. 
  94.  
  95. <Arrow>  The  four  arrow  keys  can  be  used  to  position the cursor under a 
  96. character which may be used as the start of a key for a dictionary search. 
  97.  
  98. <Enter> positions the cursor at the start of the next line. 
  99.  
  100. <e> positions the cursor at the end of the current line. 
  101.  
  102. <b> positions the cursor at the start of the current line. 
  103.  
  104. <Home> positions the cursor at the start of the screen.
  105.  
  106. <End> positions the cursor at the last line of the screen.
  107.  
  108. <Space>  triggers  a dictionary search using the string of characters beginning 
  109. with the one marked by the cursor. (See below.) 
  110.  
  111. <l>  logs  the  character  string  marked  by  the  cursor  to  a  file  called 
  112. "jreader.log".  The logged data is in MOKE's "edict" format, i.e. `kanji [kana] 
  113. /english .../', with the logged characters being inserted in the `kanji' field. 
  114. You  will  be  prompted  for  the  string  length (up to 9 characters).  If you 
  115. respond with Enter, and the cursor is on a Kanji, all the kanji in the compound 
  116. will be logged.  You are also given the option of adding up to 50 characters of 
  117. English to the logged entry.  (The  purpose  of  the  logging  function  is  to 
  118. generate  a  file  of  Japanese words which are not currently in the dictionary 
  119. file.  This file can be edited later, e.g. using MOKE, the yomikata and English 
  120. translation  added  or  modified,   and  the  entries  included  in  the   full 
  121. dictionary.) 
  122.  
  123. <y>  invokes  a scan of the "wsktok.dat" file to find the yomikata of the kanji 
  124. compound starting with the character at the cursor.  This option only works  if 
  125. the  "wsktok.dat" and "wsktok.ind" files are available,  i.e.  you need to be a 
  126. MOKE (2.0 or later) user.  The longest matching sequence is displayed,  and you 
  127. are   given  the  option  of  logging  this  entry  (kanji  and  kana)  to  the 
  128. "jreader.log" file,  along with up to 50 characters of English.  In combination 
  129. with the <l> option above, this option provides a useful way of building up the 
  130. dictionary file. 
  131.  
  132. <s> skips ahead in the text file to a line starting with "Article:". This is to 
  133. simplify reading a file containing several Japanese news items. 
  134.  
  135. <k> skips the cursor to the start of the  next  Kanji  compound.  If  Automatic 
  136. Lookup  mode  is  active,  the  dictionary is searched for this compound.  (See 
  137. below) 
  138.  
  139. <m> displays the next window of dictionary matches (if any). 
  140.  
  141. <F1> Displays a summary of the keyboard commands. 
  142.  
  143. <F2> Toggles Automatic Lookup mode (See <k> above.) 
  144.  
  145. DICTIONARY SEARCHING
  146. --------------------
  147.  
  148. The  dictionary search is similar to the one used in JDIC,  except that the key 
  149. is taken from the text being displayed,  rather than from keyboard input.  Also 
  150. the search can be on kanji keys, as well as kana and ascii. 
  151.  
  152. Starting with the character marked by the cursor,  the longest match found  and 
  153. displayed, followed by the next longest, and so on.  Usually the first match is 
  154. the one you want, although in some cases such as inflected verbs the verb entry 
  155. may be several entries down the screen.  The dictionary display is identical to 
  156. that  in  JDIC,  except  that  each  line  is preceded by the number of matched 
  157. characters.  If there are more matched lines than fit in the  window,  pressing 
  158. "m" displays the next window-full. 
  159.  
  160. YOMIKATA SEARCHING
  161. ------------------
  162.  
  163. MOKE's  "wsktok.dat"  file  contains  thousands  of  kanji compounds with their 
  164. readings in kana.  It is sorted,  and indexed on the first byte  of  the  first 
  165. character in the "wsktok.ind" file.  JREADER seeks into and scans this file for 
  166. the longest  matching  sequence  of  characters.  Only  one  such  compound  is 
  167. displayed. 
  168.                                           
  169. ADDITIONS TO PREVIOUS VERSION(S)
  170. --------------------------------
  171.  
  172. V1.1  - Yomikata lookup,  TAB expansion,  Shift-JIS reading,  PgUp for previous 
  173. screen. 
  174.  
  175. AUTHOR'S COMMENT
  176. ----------------
  177.  
  178. JREADER  is  to  me a natural extension of JDIC,  and further exploits the fast 
  179. dictionary scanning technique used therein.  It also has been  written  with  a 
  180. need  in mind.  I have been using Mark Edwards' excellent VIEW and MOKE to read 
  181. fj.* news (using the SNUZ news reader into "mtfuji".) I was frustrated  by  the 
  182. slowness  of  the English lookup in MOKE (a sequential read of the entire file) 
  183. and its refusal to add a compound to the  dictionary  if  it  was  not  in  the 
  184. kanji/kana henkan file.  Also both MOKE and VIEW require precise delineation of 
  185. the search string using several keystrokes.  This can result  in  several  slow 
  186. attempts  to find meanings for portions of a kanji compound.  What I wanted was 
  187. something friendlier and faster in a reading environment.  If JREADER seems  to 
  188. be a competitor to Mark's VIEW, well so be it. 
  189.  
  190. As ever, comments and suggestions are welcome.
  191.  
  192. Jim Breen (jwb@capek.rdt.monash.edu.au) 
  193. Department of Robotics & Digital Technology 
  194. Monash University 
  195. Melbourne, Australia                          
  196.  
  197.